1. Introduction Last updated: Mar 25th 2022

1.1 - Scope

This document provides an overview of the CMP 8.7 release with specific focus on the additional functional and non-functional enhancements with respect to CMP 8.6.

1.2 Audience

This document is aimed at internal and external audiences familiar with CMP, to explain the key features of the release including any changes in how existing functions or processes are working.

2 - Overview of Changes

With respect to CMP 8.6, CMP 8.7 introduces new functionality as well as changes to existing functionality and non-functional improvements. These changes can be summarised as follows:

2.1 - New Functionality

2.1.1 - Serial Number Categorisation

In CMP 8.6, the Managed Number Load job was responsible for uploading a range of serial number e.g. MSISDNs, into the CMP database for use when creating new subscribers or when performing a number change on an existing subscription. The file of serial number ranges supported the definition of a price per range of numbers but there was no way to categorise the numbers so that a specific type of number could be selected as part of the installation.

In CMP 8.7, a service code has been added to the JSON schema of the load file allowing different service codes to be associated with different ranges of numbers. The service code is assigned to the subscription to charge either a recurring or one-off fee for the specific number selected. AgentView and the RESTful POST Serial Numbers web service now support filtering by service code when selecting a number for use, enabling a specific category of number, and charge, to be applied to the subscription.

2.1.2 - Cross Product Discounts

CMP 8.6 supported normal service discounts that allows a subscriber to be discounted on a particular subscription service. Discounts can be tiered based on the value of the service and discounts can be percentage-based or defined as a fixed amount.

In CMP 8.7, the discounts functionality has been extended to support cross product discounts which are based on the service subscribed to. Cross Product Discounts works in the same way as a normal discount, the difference being how a subscription becomes eligible for the discount. With a cross product discount, the subscription receives a discount based on the a number of connections (min or max) to either a network, a Network and Network type and/or a Price Plan. Various permutations of the criteria are supported e.g. 10 connections on Price Plan X and 5 on Network A. Collectively, these are know as the cross product eligibility rules. These connections must also be at the selected level - Agreement, Account, Corporate or Group e.g. there must be 10 connected subscriptions on a price plan for this corporate that the subscription is part of. Subscriptions qualify for a cross product discount scheme providing the eligibility rule has been met at billing time.

2.1.3 - Copy Invoice

If a subscription is accidently added to the wrong account and subsequently invoiced, either individually or as part of a consolidated invoice, then it becomes necessary to effectively move the invoice charges from the old to the new account. In CMP 8.6 this could be achieved be reversing the original invoice, using the 'Reverse Full Invoice' option from the Transactions lower panel on the invoiced account, to adjust the overall account balance by the total invoice amount, and then creating a sales ledger adjustment against the account the subscription is moving to reflect the charge/credit that should be on the other account. This was a complicated process for the agent to follow.

In CMP 8.7, this process has been simplified by introducing a new right-click menu option, 'Copy Invoice', that allows the charges for a reversed to be applied automatically to another account.

2.1.4 - Active Card Swap

In CMP 8.6, if an account was marked as a card payer i.e. the payment type of the account was 'Credit/Debit Card Payment', then the only way to change the card that they are using for recurring payments was to cancel the existing card, which changes the account back to a manual payer, and then change the payment type again to Credit/Debit Card.

CMP 8.7 now supports the ability to select an existing one-off card that hasn't expired and make this the active card on the account. This is achieved through a new right-click option, 'Make Active'.

2.2 - Changed Functionality

2.2.1 - Subscriber Disconnection

In CMP 8.6, disconnection of a subscriber was driven by the AgentView user raising a disconnection workflow event against the subscription. This was not particularly intuitive and relied on the user knowing the disconnection events that were configured in the system.

In CMP 8.7, the subscriber disconnection process has now been implemented as a new wizard driven from the CMP 8.6 Subscription Creation/Upgrade Wizard. Details of the wizard are provided below.

2.2.2 - Higher Entity linked Events

When configuring a linked event in CMP 8.6, it was only possible to link an event to another that was raised at the same level(s). In CMP 8.7, this has been extended so that a linked event can now to be generated at levels higher than the event that triggered the linked event(s). If the linked event is configured to be generated at account only or agreement level only, and the initial event was generated at subscription level then the new event is generated for the subscription's account or agreement.

2.2.3 - Purchase Link Event Comms

CMP 8.4 provided the capability of sending a communication to the end subscriber when purchasing a bolt-on or top-up package. This communication can provide details of the specific purchase within the comms message such as the package name and price for example.

With the introduction of the capability to generate workflow events to higher entities with linked events in CMP 8.7, it is now possible to send a purchase notification to a higher entity e.g. account, as well as to the subscriber making the purchase. This is achieved by linking a workflow event, with a linked comms, that is configured to be raised at account, agreement, corporate or group level, to a configured purchase workflow event. The comms on the linked event can now be configured to include attributes of the subscriber's purchase.

2.2.4 - Failed Comms

In CMP 8.6, if a communication failed to be sent out to an end customer, it was not possible for an agent to understand why. CMP 8.7 introduces a new right-click option, available on the Comms lower panel, that allows the details of an errored, or not sent communication, to be displayed.

2.2.5 - Card Assignment

The CC/DC Details popup that is available by right-clicking on a card in the Credit Cards Lower Panel, accessible from the Account Summary screen, has been enhanced in CMP 8.7 to allow the card to be assigned explicitly to a subscription. This prevents the card being used for purchases by other subscriptions on the account.

2.2.6 - Administration Console Changes

Daily Operations - Jobs

The following jobs have been updated in CMP 8.7 with an impact on the corresponding existing JSON schemas:

  • Managed Number Load - the schema has changed to support specification of a service code for a range of serial numbers. The JSON schema version has been updated to version 1.1
  • Bill Print - the schema has changed to include the period start and end dates for the billed accounts and any product and subscription attributes associated with the subscriber's Price Plan. The JSON schema version has been updated to version 1.5

In addition, the data warehouse extracts for unbilled and billed usage have change to include foreign network details for roamed calls. The version of the extract has been updated from version 1.0 to version 1.1.

Further changes to batch jobs that have no impact on the data output are described below.

System Monitoring

In CMP 8.6, the queues used by CMP to send messages in real-time to external systems such as an SMS Gateway or Online Charging System were only visible through the ActiveMQ client application. This meant that not all information required to holistically monitor CMP was available through the Administration Console. In CMP 8.7, the ActiveMQ queues are now accessible through the administration console.

3 - Impacts on CMP

The functional and non-functional changes highlighted in section 2 above have had an impact CMP in the following areas:

  • New and changed AgentView screens
  • Bulk Action changes
  • Admin Console changes
  • New and changed Business Configuration screens
  • SOAP web services changes
  • RESTful web services changes
  • Integration adapter changes
  • Openet-specific adapter changes
  • Lifecycle-specific adapter changes
  • UK-specific adapter changes.

3.1. AgentView

3.1.1. New Screens

3.1.1.1. Subscriber Disconnection Wizard

CMP 8.7 introduces a new wizard-driven disconnection process that has been integrated into the CMP 8.6 Subscription Creation/Upgrade Wizard. The Subscription Creation/Upgrade wizard has now been renamed to the Subscription Management wizard to better align with the business processes available through the wizard.

Subscription Management Popup

On selecting the Disconnection radio button and clicking Next, the user is presented with the Disconnection Subscription panel. From here the user can select the disconnection workflow from those configured, a reason for disconnection and any additional notes, the date the disconnection is to be processed and the user can also select whether the subscriber data be anonymised after disconnection and once all outstanding debt is cleared. If the 'Terminate Subscriber' checkbox is checked then any termination fees payable after disconnection are also displayed.

Disconnect Subscription Panel

On clicking Finish, the disconnection workflow is raised to process or schedule the disconnection.


3.1.2. Changed Screens

3.1.2.1. Transactions Lower Panel

As described above, CMP 8.7, provides a new right-click menu option, 'Copy Invoice', that enables a reversed invoice to be charged to another account. Selecting this option provides a popup to enter the account number to apply the charges/credits to. The 'Find' button allows an account search and the 'Display' button provides the agent with an on-screen verification that the account entered/selected is the one intended. This new right click option is only available for agents that have the 'COPYINV' function security assigned to their role.

Copy Invoice Popup

3.1.2.2. Comms Lower Panel

As described above, CMP 8.7 introduces a new right-click option from the Comms lower panel, available from the Comms swish on the Account or Subscription Summary screens, that allows the details of an errored or not sent communication to be displayed.

Comms Error Details Popup
Comms Not Sent Popup

The same right-click options to view the error, or reasons that a communication wasn't sent, are also available from within the workflow event Summary Screen for the workflow event that generated the failed communication.

3.1.2.3. Credit Cards Lower Panel

CMP 8.7 now supports the ability to select an existing one-off card that hasn't expired and make this the active card on the account. This is achieved through a new right-click option, 'Make Active'. The option is available on one-off cards that are not expired provided the account is a recurring card payer (i.e. the account's payment type has a payment method of credit or debit card and the account has an active card). Selecting this new option prompts the user for confirmation and, if affirmative, makes the selected card active and the existing active card one-off.

Change Active Card

3.1.2.4. CC/DC Details Popup

The CC/DC Details popup, available by right-clicking on a card in the Credit Cards Lower Panel that is accessible from the Account Summary screen, has been enhanced in CMP 8.7 to allow the card to be assigned to a specific subscription. The CC/DC Details popup now provides a dropdown of subscriptions under the account that can be associated with the selected card. The dropdown is only available for on-off cards.

CC/DC Details Popup

3.1.2.5. Event Summary Screen

CMP 8.6 introduced the ability to assign a Salesperson to web service requests to create a new subscription, change MSISDN or change Price Plan. In CMP 8.7 this salesperson can now be viewed in the Workflow Event Summary panel for the associated workflow events.

Subscription Event Summary

3.1.2.6. Account Payments Lower Panel

In the Payments sub-menu option of the Financials swish within the Account Summary, there is a right click option to manually add a payment. The subsequent panel that is displayed will redirect the agent to a payment webpage if there is a direct payment integration from CMP. In CMP 8.6 this option was available to the AgentView user whether there was a direct payment integration or not.

In CMP 8.7, a new system property has been introduced, PAYMENT.INTEGRATION that indicates whether there is direct payment gateway integration or not. If set to 'false' i.e there is no payment gateway integration, then the 'Add Payment' right-click option is not available.

3.1.2.7. Purchases Screen

The new payment integration system property described in section 3.1.2.1 above has also been applied to the Purchases popup panel available from the Financial swish on the Subscription Summary screen. The right-click options to 'Purchase a TopUp' and 'Purchase a Bolt On' are now disabled if system property 'PAYMENT.INTEGRATION' is set to 'False'.

3.1.2.8. Discounts Lower Panel

CMP 8.7 introduces a new type of discount, cross product discounts, that allows a discount to be applied to a subscription service based on the overall product subscriptions on the account, agreement, Corporate or Group e.g. there must be 10 connected subscriptions on a price plan for this corporate the subscription is part of. The cross product discount is based on the eligibility rules defined for the cross product discount. These eligibility rules determine the number of subscriptions (connections) to either a specific network and/or a Network and Network type and/or a specific Price Plan. Various permutations of these are supported.

CMP 8.7 allows cross product discounts to be assigned to a subscription through the Discounts lower panel accessible from the Billing swish on the subscription Summary screen.

3.2. Bulk Actions

3.2.1. New Bulk Actions

CMP 8.7 does not provide any new Bulk Actions.


3.2.2. Changed Bulk Actions

CMP 8.7 does not provide any enhancements to the existing Bulk Actions.

3.3. Admin Console

3.3.1. Daily Operations

3.3.1.1. New Jobs and Daemons

There are no new jobs or daemons released as part of CMP 8.7.

3.3.1.2. Changed Jobs

Managed Number Load

In order to allow serial numbers to be categorised and have an associated subscription charge applied if used on a subscription, the Managed Number Load job has been enhanced to allow for a service code to be associated with a particular serial number or ranges of serial numbers. To support this, a new optional element Service Code has been added to the Managed Numbers JSON schema after the existing Price element. If a Service is supplied, then it is validated as being a valid service of category 'subscription serial number'. If both a service and price are supplied, the price entered is validated against the min and max prices of the service. If a service is supplied without a price then use the default price configured for the service will be used.

The Managed Number Load JSON schema has been updated to version 1.1.

Invoice Production

CMP 8.7 introduces support for cross product discounts that allows a discount to be applied to a subscription at billing time if the cross product eligibility criteria are met. This capability is described further above.

Bill Print

In CMP 8.6, the Bill Print job was responsible for generating the outbound bill print file and, if configured, automatically transmitting the file to the print bureau. If the transmission failed for some reason, then the file wasn't generated. If the transmission was successful, the bill print file wasn't stored so it meant that, in both cases, no bill print file was available on the file storage system for subsequent retransmission.

For the CMP 8.7 release, the transmission of the file has been split into a separate Bill Print Transmission daemon. If the daemon cannot transmit the file to the external print bureau then the file is stored in an error directory for later reprocessing. If the file is transferred successfully then the file is persisted on file storage.

In addition, the bill print JSON has been enhanced to provide the following additional information:

  • The detailedbills section has changed after the existing serviceId element in the serviceIdentifiers array to include the UsagePeriodStartDate and UsagePeriodEndDate. The UsagePeriodStartDate is the start date of usage and usage base allowances for this billing period and similarly the end date is the corresponding end date of usage and usage base allowances for this billing period.
  • The existing Plan section has been expanded to hold and product and subscription attribute information that may be defined against the price plan. A new attributes array has been added after the existing description object. Each array element has the following attributes:
    • attributeDescription - Description of the price plan attribute
    • attributeValue - Price plan attribute value

The Bill Print JSON schema has been updated to version 1.5.

Data Warehouse Extract Jobs

In CMP 8.7, additional fields have been added to the Rated Usage table (usage direction, mobile country code and mobile network code) that have now been included on the data warehouse extracts for unbilled and billed usage. The following fields have been added before the audit timestamp:

  • Usage Direction - If populated in the rated usage table this has a value of either MO (Mobile Originating) or MT (Mobile Terminating)
  • Mobile Country Code - If populated in the rated usage table this is the ITU-T Recommendation E.212 mobile country code of the roamer from where they made (MO) or received (MT) the rated call/text.
  • Country Name - If the Mobile Country Code field is populated in the rated usage table, then this is the name of the country the subscriber is roaming in.
  • Mobile Network Operator - If populated in the rated usage table this is the ITU-T Recommendation E.212 mobile network code of the roamer from where they made (MO) or received (MT) the rated call/text.
  • Mobile Network Operator Name - If the Mobile Network Operator field is populated in the rated usage table then this is the name of the foreign mobile operator.

The version of the extract has been updated from version 1.0 to version 1.1.

Archive Management Job

The Archive Management job, introduced in CMP 8.6 has been enhanced to incorporate the management of rated usage and rate usage allowance partitions. The same archive server directory is applicable for all partitions that are handled by this job.

The job looks at partitions associated with both the Rated Usage and Rated Usage Allowance tables. For partitions that were created prior to, or on, the calculated cut-off date, then these are dropped. If the archive required property is set to 'Yes', then a copy of the partition is transferred to the archive directory on the archive server.

Interface Purge Job

The Interface Purge job was initially developed in CMP 8.1.2 to drop partitions from the Interface Batch Detail, Usage Batch Detail and Usage Allowance Batch Detail tables. In CMP 8.7, this job has been enhanced to drop additional partitions for other child tables associated with the Interface Batch Detail table namely:

  • WholesaleUsageBatchDetail_discard_date
  • PaymentBatchDetail_discard_date
  • PaymentCardBatchDetail_discard_date
  • PaymentUploadBatchDetail_discard_date
  • BankPaymentBatchDetail_discard_date
  • PrePayBatchDetail_discard_date
  • DRAExtractBatchDetail_discard_date
  • DRAResponseBatchDetail_discard_date
  • CreditReferenceExtractBatchDetail_discard_date
  • CreditControlInterfaceBatchDetail_discard_date
  • InterfaceBatchDetailBreakdown_discard_date
  • InterfaceBatchDetailEnvelope_discard_date
  • LedgerBatchDetail_discard_date
  • BulkActionInterfaceBatchDetail_discard_date
  • ExternalReferenceBatchDetail_discard_date
  • GeneralLedgerPaymentBatchDetail_discard_date
  • BondRedemptionBatchDetail_discard_date
  • GeneralLedgerPurchaseBatchDetail_discard_date

3.3.2. System Management

No changes have been made to any of the options within the System Management menu option in CMP 8.7.


3.3.3. System Monitoring

In CMP 8.7, the ActiveMQ queues, previously accessible through a separate ActiveMQ user interface, are now accessible through the administration console. For each queue it is possible to drill down to see the messages on the queue and associated message details. The message queue interface is available through a new System Monitoring menu option, Message Queues.


3.3.4. System Configuration

No changes have been made to any of the options within the System Configuration menu option in CMP 8.7 .


3.3.5. System Administration

No changes have been made to any of the options within the System Administrator menu option in CMP 8.7 .

3.4. Business Configuration

3.4.1. New Business Configuration Screens

3.4.1.1. Attributes Menu Option

CMP 8.7 introduces a new sub-menu option under the Propositions main menu option called Attributes. Attributes can be associated with Products (Price Plans or Packages) to extend the information held against a specific product.

Three further sub-menu options are provided to allow configuration of Product Attributes, Product Templates and Product Groups:

  • Product Attributes provide additional static information about a product that is not available through the main product configuration screens. This could be the bandwidth of a broadband product for example. Each attribute can be defined with a default value.
  • Product Templates provide a way to associate a set of Product Attributes to a product in one step rather than associating attributes individually. In CMP 8.7, a Product Template can be associated with a Price Plan which means that all the template attributes will be automatically associated with the Price Plan.
  • Product Groups provide a way of grouping together similar product attributes.

3.4.1.2. Add Contract

CMP 8.6 provided the ability to configure and maintain contracts through Business Configuration but did not provide the ability to add new contracts. This capability has now been added for CMP 8.7.

The Add Contract screen is accessible from the Contract List View, available from the Customer Management main menu option.

Note

Although a Delete button is provided on the screen, this has not yet implemented and will be supported in a later release of CMP.

3.4.2. Changed Business Configuration Screens

3.4.2.1. Allowances Menu Option

The Add, Edit and View Allowances panels have been enhanced to include the network for which the allowance is applicable, the Usage Class Group that defines the specific usage that contributes to the consumption of the allowance and a priority to provide an indication of what order similar allowances are consumed in. The attributes have been added to provide support for different types of network to which CMP can integrate for online and offline charging. The View panel has also been enhanced to show any notification thresholds associated with the allowance.

In addition, the List panel has been enhanced to now show the network that the allowance is available for. The column can be sorted.

3.4.2.2. Discounts Menu Option

The Add Discount Scheme screen has been modified to include a Discount Type dropdown to support additional types of discounts that will be introduced in future releases of CMP. In CMP 8.7 only normal service discounts are fully supported. The List view has also been enhanced to show the discount type within the list of available discount schemes. A new Links button has also been added to the list panel to allow services to be linked to a Normal discount and to allow eligibility rules to be defined for a Cross Product Discount. Further tabs have been added to support usage discounts and invoice volume discounts in future releases of CMP.

The new Eligibility Rules tab allows rules to be configured that are used in billing to determine whether a subscription qualifies for the discount or not.

Note

Although Edit and Delete buttons are provided on the List panel and the Eligibility Rules tab, these have not yet been implemented and will be supported in a later release of CMP.

3.4.2.3. View Spend Caps

In a similar way to the Allowances View panel above, the View Spend Cap panel has been enhanced to also include the network that the spend cap is associated with, the Usage Class Group that defines the specific usage that contributes to the consumption of the spend cap as well as any notification thresholds associated with the spend cap.

3.4.2.4. Edit Price Plan

The Edit Price Plan option has been enhanced to optionally allow a Product Template and a subscription attribute group to be associated with the Price Plan. The Product Template extends the basic Price Plan configuration with additional static attributes to further describe it. The subscription attribute group allows dynamic Price Plan attributes to be captured during the installation process.

3.5. SOAP Web Services

3.5.1. New Web Services

No new SOAP web services have been introduced as part of the CMP 8.7 release.


3.5.2. Changed Web Services

No SOAP web services have been changed as part of the CMP 8.7 release:

3.6. RESTful Web services

3.6.1. New Web Services

No new RESTful web services have been introduced as part of the CMP 8.7 release.


3.6.2. Changed Web Services

3.6.2.1. POST Serial Numbers Web Service

The POST Serial Numbers RESTful web service has been updated to include an additional Service Code filter that allows specific serial numbers to be returned based on the service code that is assigned to them. The service code can be used to identify high-value serial numbers.

3.7. Integration Adapters

No changes have been made to integration adapters in CMP 8.7.

3.8. Openet Adapter

The Openet-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.

No changes have been made to the Openet adapter as part of CMP 8.7.

3.9. Lifecycle Adapter

The Lifecycle-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global.

With the introduction of the Synchronous Allowance Manager(SAM) module in CMP 8.7 to support multiple Online Charging Systems(OCS) implementations, all configuration for connectivity to Openet is now held against the Openet Adapter rather than at system level.

3.10. UK-specific Adapters

The Lifecycle-specific adapters are optional components of the CMP deployment that are based on the licence agreement with MDS Global. With the introduction of the Synchronous Allowance Manager (SAM) module in CMP 8.7 to support multiple Online Charging Systems (OCS) implementations, all configuration for connectivity to Lifecycle is now held against the Lifecycle Adapter rather than at system level.

4 - Product Fixes

In addition to functional and non-functional changes and improvements, the CMP 8.7 product also addresses a number of application support issues. This section provides a summary of the issues fixed in this release.

The following issues have been addressed within this release:

Reference Area Description
CMPIS-2285Business ConfigurationIn the Tariff Packages screen, Bolt On packages were not being presented for selection.
CMPIS-2277Business ConfigurationIt was not possible to add a new Product Attribute.
CMPIS-2269AgentViewIt was not possible to suspend an agreement from invoicing.
CMPIS-2268RefundsWhen adding a refund to an account no workflow event was created even though the workflow event was correctly configured on the workflow event properties table.
CMPIS-2267Wholesale ReconciliationThe field used to hold the wholesale usage units was insufficient to hold large data volumes greater than 953MB.
CMPIS-2266Business ConfigurationWhen inserting a record into the Price Plan table via the Prie Plan View, the insert failed.
CMPIS-2263Admin ConsoleActiveMQ message details were not being displayed correctly through the Administration Console.
CMPIS-2261Admin ConsoleThe Message Queues displayed in the Administration Console were associated with a different environment.
CMPIS-2260Wholesale ReconciliationLong filenames of the wholesale usage files caused issues in writing to the interfaceBatchDetails table.
CMPIS-2252Admin ConsoleManual changes of module properties were preventing any future configuration changes.
CMPIS-2248Business ConfigurationIt was not possible to Edit or View a Thai SMS notification message once created.
CMPIS-2234Admin ConsoleWhen creating a new user in the admin console, if a password was entered that did not meet the complexity requirements an error message was no longer displayed as expected.
CMPIS-2207Web ServicesA REST endPackage request failed with Null Pointer Exception.
CMPIS-2086PurgeThe Interface Purge job was not correctly obtaining the sequence number from Hazelcast
CMPIS-2070AgentViewAttempting to view non-subscription invoice details through the transactions lower panel threw an incomplete error.
CMPIS-1866CommsA Comms request got stuck at 'Awaiting Distribution' after failing to connect to the email server.
CMPIS-1827Web ServicesIn AgentView when attempting to purchase a bolt-on, the Balance option should not have been selectable for a prepaid subscription that was not connected.
CMPIS-1394AgentViewNotes entered when enabling/disabling a feature were not stored in the workflow event notes.
CMPIS-1213AgentViewIn certain circumstances it was not possible to view a corporate structure.

5 - Documentation

5.1 - Product Documentation

The product documentation is available online on the documentation portal. This online portal requires authorised access, which can be obtained by contacting MDS Global support. The documentation is also available as downloadable PDFs as follows:

Document Version Document Changes
Installation Guide 1.0 The installation Guide has been updated to include a new section on installing the new Help module.
Technical Architecture 1.0 There are no updates to the Technical Architecture document as part of CMP 8.7.
CMP Overview 1.0 There are no updates to the CMP Overview as part of CMP 8.7.
Documentation Overview 1.0 The Documentation Overview has been updated to include a new topic, "Online Help” to explain the new help module released as part of CMP 8.7.
System Administration Guide 1.0 There are no updates to the System Administration Guide as part of CMP 8.7.
Security Guide 1.0 There are no updates to the Security Guide as part of CMP 8.7.
Operational Overview 1.0 The Operational Overview has been updated for the changes to the Managed Number Load job.
Business Configuration Overview 1.0 The Business Configuration Guide has been updated to cover the changes above.
Billing Functionality Guide 1.0 There are no updates to the Billing Functionality Guide as part of CMP 8.7.
Communications Functionality and Configuration Guide 1.0 Changes have been made to the Communications Guide for the changes made to view error details for failed communications.
Payments Functionality Guide 1.0 There are no updates to the Payments Functionality Guide as part of CMP 8.7.
Extracts Guide 1.0 The format of the Unbilled Usage and Billed Usage Analytics extracts has been updated to reflect the changes detailed above.
Purge Guide 1.0 There are no updates to the Purge Guide as part of CMP 8.7.
Standard Reporting 1.0 There are no updates to the Standard Reporting Guide as part of CMP 8.7.
Batch Jobs and JSON Schemas Guide 1.0 The Batch Jobs and JSON Schemas Guide has been updated to include the changes to the Bill Print and Managed Numbers Load jobs.
RESTFul Web Services API Guide 1.0 The REST web services guide has been updated in line with the changes described above.
SOAP Web Services Semantics Guide 1.0 The SOAP web services guide has been updated in line with the changes described above.
Business Configuration RESTFul Web Services API Guide 1.0 There are no updates to the Business Configuration REST Guide as part of CMP 8.7.

5.2 - Online Documentation

Online help is available in AgentView, Business Configuration, the Administration Console and the Bulk Actions console. The following table summarises the current versions of the online help and the changes since CMP 8.6:

Online Help Version Document Changes
AgentView 8.7.1.0 CMP 8.7 introduces a new HTML 5 context-sensitive help module that replaces the old JavaHelp. The following topics have been updated as a result of changes made to AgentView in CMP 8.7:
  • Subscription Management including the new disconnections wizard
  • Comms error and not sent details
  • Payment by Credit Card.
Business Configuration 1.13 The following changes have resulted in changes to Business Configuration online help:
  • New option to add a Contract
  • Changes to the Add Discount Scheme option
  • Changes to Allowance panels
  • Changes to the View Spend Caps panel
  • Changes to the Edit Price Plans panel.
Administration Console 1.10 The admin Console help has been updated in line with the introduction of the Message Queues menu option.
Bulk Action Console 1.4 No changes have been made to the Bulk Action help.

6 - Release Upgrade

The CMP 8.7 installer includes the capability to upgrade a CMP 8.6 installation without the loss of configuration or customer data provided that the software, file system and database structure of the installation in question are at no point manually modified.

Important

The CMP 8.7 Installation Guide, and the details below, should be read before attempting the upgrade to CMP 8.7.

It is important that the following sections are read prior to performing the upgrade, specifically the Configuration Changes section, as it may be advisable to backup relevant configuration prior to performing the upgrade to ensure the configuration can be replicated, if necessary, post upgrade.

6.1. Upgrade Notes

The CMP 8.7 upgrade now includes an HA (High Availability) instance of Active MQ to be able to switch to that instance in the event that the main queue is down. Messages from the main queue would be copied across to HA version. The administration Console message queues integration retrieves the ActiveMQ console URL from based on the currently active instance.

6.2. Inventory Manager Changes

6.2.1. Global Section

In the Common Application Properties section of the Global section of the inventory manager, the OCS Implementation dropdown has been renamed to SAM Implementation to allow for CMP to be deployed in offline mode with no OCS integration. 'SAM' stands for 'Synchronous Allowance Management' and this is the new name for the OCS Synchronous Provisioning Interface.

6.2.2. SAM Services Section

A new section, SAM Services has been added for CMP 8.7 to support configuration of the new CMP module supporting multiple OCS implementations as well as CMP running in offline mode i.e. with no OCS integration.

6.2.3. Context Sensitive Help Section

In CMP 8.7, the old JavaHelp has been replaced by new HTML 5 help that provides a consistent look and feel to other CMP help implementations. A new section has been added to the Inventory Manager to support the configuration.

6.2.3. ActiveMQ Section

In CMP 8.7, the ActiveMQ installation is now part of the CMP product deployment and will be deployed as part of installation. The instance installed will now be exposed through the new Message Queues menu option available through the System Monitoring section of the Administration Console.

6.3. Third party libraries

The following third-party libraries will be updated as part of the installation/upgrade:

  • Spring Batch will be upgraded to version 4.2.7
  • Spring Boot will be upgraded to version 2.3.11

6.4. Database Changes

6.4.1. New Tables and Views

The following table has been added to the database schema with respect to CMP 8.6:

  • NetworkDisconnectDiaryEvent - holds the workflow event type and codes that can be used when disconnecting a subscriber through the new disconnection wizard.

The following views have been added to the database schema with respect to CMP 8.6:

  • attributeGroup - view over the CHBAREP table
  • productAttribute - view over the CVBIREP table.

6.4.2. New Attributes

The following table attributes have been added in CMP 8.7:

  • Table accountPaymentPlan, attributes AuditUser, AuditProcess and AuditTimestamp
  • Table allowance, attributes UsageClassGroupCode, Priority and NetworkCode
  • Table CSIUCPP (Subscription Price Plan), attributes IUCICD (companyNumber) and AttributeGroup
  • Table ratedUsage, attributes UsageDirection, MobileCountryCode and MobileNetworkCode
  • Table serialNumberLoadBatchDetail, attribute ServiceCode
  • Table usageAllowanceBatchDetail, attribute AllowanceId
  • Table usageBatchDetail, attributes mobileCountryCode, MobileNetworkCode and UsageDirection
  • Table usageCap, attributes networkCode and usageClassGroupCode

6.4.3. Dropped Attributes

No table attributes have been dropped in CMP 8.7.


6.4.4. Modified Attributes

The following table attributes have been modified in CMP 8.7:

  • For table alertHistory, attribute auditDateTime has been changed to auditTimestamp
  • For table alertHistoryRecipient, attribute auditDateTime has been changed to auditTimestamp
  • For table alertRecipient, attribute auditDateTime has been changed to auditTimestamp
  • For table C1BMREP (Network Extension), attribute BMZMTY (International Prefix) has changed from CHAR(3) to CHAR(5)
  • For table calendar, attribute audit_date_time has been changed to auditTimestamp, audit_user has been changed to auditUser and audit_process has been changed to auditProcess
  • For table global_outage, attribute audit_date_time has been changed to auditTimestamp, audit_user has been changed to auditUser and audit_process has been changed to auditProcess
  • For table interfaceBatchHeader, attribute auditDateTime has been changed to auditTimestamp
  • For table interfaceJobControl, attribute auditDateTime has been changed to auditTimestamp
  • For table jobNote, attribute auditDateTime has been changed to auditTimestamp
  • For table probeHistory, attribute auditDateTime has been changed to auditTimestamp
  • For table probeNote, attribute auditDateTime has been changed to auditTimestamp
  • For table probeSuspension, attribute auditDateTime has been changed to auditTimestamp
  • For table probeVersion, attribute auditDateTime has been changed to auditTimestamp
  • For table recipient, attribute auditDateTime has been changed to auditTimestamp
  • For table schedule, attribute audit_date_time has been changed to auditTimestamp, audit_user has been changed to auditUser and audit_process has been changed to auditProcess.

6.5. Configuration Changes

6.5.1. Manual Business Configuration

As part of CMP 8.7, a number of changes specified above require additional configuration data to be added using the CMP Business Configuration. These are summarised as follows:

6.5.1.1. Workflow Events

The introduction of support for the copy invoice functionality and the linked event functionality defined above requires new workflow events to be configured through the Workflow -> Event Types and Event Codes Business Configuration option. These are suggested workflow events:

Event TypeEvent CodeDescriptionNotes
AAAMICPYCopy Invoice-S/L AdjustCopy Invoice-S/L Adjust
PRCHSUCLSuccessful Purchase - LinkedThis should be set to ONLY be raised at account level.

Note - Copy Invoice Workflow Event

The workflow event to be configured for the copy invoice functionality needs to match the event type and code configured in the Workflow Event Properties table below. If a different workflow event is created for the copy invoice functionality then the workflow event property should be changed accordingly.

Note - Link Event

As described above, the linked event functionality can be used to send a notification to the account of the subscription associated with the purchase event. To support this, the link event must have a comms associated and linked to workflow event that is configured to be raised on successful purchase.

6.5.2. Manual Online Charging System Configuration

As the Synchronous Allowance Manager(SAM) module introduced in CMP 8.7 supports multiple Online Charging System(OCS) implementations, configuration specific to the Openet or Lifecyle OCS implementation now needs to be set for the corresponding adapter rather than at system level. Due to this, immediately following the upgrade to CMP 8.7 it will no longer be possible to provision or query OCS allowances from anywhere in CMP and the provisioning adapter for the OCS being used (e.g. sabre-openet-provisioning-adapter) will be found in a state of “Deployment Failed” in the Administration Console with a list of connection properties highlighted as requiring completion.

To restore connectivity to the OCS, the required properties should be populated and the provisioning adapter redeployed. The values for these properties have been previously configured at system level and, if they are not known, can therefore be retrieved from the database by executing the query: SELECT parametername, parametervaluetouse FROM systemproperties

6.5.3. Standard Data Population

As part of CMP 8.7, the standard data population scripts used to auto-populate a number of CMP configuration tables for a greenfield installation have been updated. For existing installations, this configuration will be automatically injected into the appropriate database table:

6.5.3.1. Workflow Event Properties

The introduction of support for the copy invoice functionality requires new workflow event property configuration through the System -> Workflow Properties Business Configuration option. The following new properties are required if the copy invoice function is to be supported:

Property GroupProperty NameEvent TypeEvent Code
FINANCIALinvoice.copy.eventAAAMICPY

6.5.3.2. System Properties

Specifying whether CMP has direct integration to a Payment Gateway to control taking payments through AgentView has been implemented in CMP 8.7 using the following new system property:

Parameter GroupParameter NameParameter Value
GENERIC.PAYMENTSPAYMENT.INTEGRATIONTrue

6.5.3.3. Group Roles

Both AgentView and the SOAP web services use a common authorisation mechanism when performing updates to CMP customers. As a result, the following SOAP group roles have been extended on the groupRoles table to support additional functional security:

Parent RolesRoles
soap-ws-allmaintain-customers
soap-ws-basicmaintain-customers
soap-ws-customermaintain-customers
soap-ws-ordermaintain-customers
soap-ws-billingmaintain-customers
soap-ws-financialmaintain-customers

6.5.3.4. Function Security

With the introduction of the copy invoice functionality, the following new role-based function security has been added to the function security table (roleDiseFunctionName):

FunctionAreaFunction NameRole
Copy InvoiceFinancials -> TransactionsCOPYINVadd-adjustments

6.5.3.5. Interface Job Control

The following updates have been made to the interfaceJobControl table as a result of changes to the jobs mentioned in section 3.3.1.2 above:

JobJob CodeVersion
Bill PrintSABREBIO03v1.4
Data Warehouse Billed UsageSABREDWO58v1.1
Data Warehouse Unbilled UsageSABREDWO01v1.1
Managed NumbersSABRENMI01v1.1